Added Human-Readable ABI format #557
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for taco-nft-demo canceled.
|
✅ Deploy Preview for taco-demo canceled.
|
Comment on lines
83
to
84
| delete jsonAbi.constant; | ||
| delete jsonAbi.payable; |
There was a problem hiding this comment.
Why do we delete these fields? Can we use destructuring and only pick relevant fields instead?
Comment on lines
86
to
93
| jsonAbi.inputs = jsonAbi.inputs.map((input: any) => ({ | ||
| ...input, | ||
| internalType: input.type, | ||
| })); | ||
| jsonAbi.outputs = jsonAbi.outputs.map((output: any) => ({ | ||
| ...output, | ||
| internalType: output.type, | ||
| })); |
There was a problem hiding this comment.
Why do we need to map type to internalType? To be consistent with JSON ABI schema?
Comment on lines
113
to
128
| z | ||
| .string() | ||
| .refine( | ||
| (abi) => { | ||
| try { | ||
| toJsonAbiFormat(abi); | ||
| return true; | ||
| } catch (e) { | ||
| return false; | ||
| } | ||
| }, | ||
| { | ||
| message: 'Invalid Human-Readable ABI format', | ||
| }, | ||
| ) | ||
| .transform(toJsonAbiFormat), |
There was a problem hiding this comment.
Let's move this variable into a separate declaration, just like functionAbiSchema, humanReadableAbiSchema?
Comment on lines
146
to
148
| interface ContractConditionHumanReadableAbi extends ContractConditionProps { | ||
| functionAbi: string; | ||
| } |
There was a problem hiding this comment.
Why not infer it using z.infer?
Comment on lines
151
to
156
| constructor(value: OmitConditionType<ContractConditionHumanReadableAbi | ContractConditionProps>) { | ||
| if (typeof value.functionAbi === 'string') { | ||
| value.functionAbi = toJsonAbiFormat(value.functionAbi); | ||
| } |
There was a problem hiding this comment.
Why do we need to update this constructor and add a type invariant? Can we update ContractConditionProps (z.infer) instead?
| }); | ||
| }); | ||
|
|
||
| it('converts human-readable ABI to JSON ABI format', () => { |
There was a problem hiding this comment.
You can test the low-level behavior of humanReadableAbiSchema here
piotr-roslaniec
requested review from
KPrasch,
cygnusv,
theref,
derekpierre,
vzotova,
manumonti and
piotr-roslaniec
theref
approved these changes
Jul 30, 2024
piotr-roslaniec
approved these changes
Jul 31, 2024
vzotova
approved these changes
Jul 31, 2024
andresceballosm
force-pushed
the
human-redeable
branch
from
37b0b86
to
b29b131
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of PR:
Required reviews:
What this does:
Issues fixed/closed: